<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qwt User&#39;s Guide: QwtLegendData Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Qwt User&#39;s Guide
   &#160;<span id="projectnumber">6.1.4</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_qwt_legend_data.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_qwt_legend_data-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">QwtLegendData Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Attributes of an entry on a legend.  
 <a href="class_qwt_legend_data.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="qwt__legend__data_8h_source.html">qwt_legend_data.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aaa33cc8e6aec17440df5d4c38d7545b7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#aaa33cc8e6aec17440df5d4c38d7545b7">Mode</a> { <a class="el" href="class_qwt_legend_data.html#aaa33cc8e6aec17440df5d4c38d7545b7add4342fbe2d82828b9ef7031c1b41a0b">ReadOnly</a>, 
<a class="el" href="class_qwt_legend_data.html#aaa33cc8e6aec17440df5d4c38d7545b7a39077c66db9fe2faf4d85a6f9266583f">Clickable</a>, 
<a class="el" href="class_qwt_legend_data.html#aaa33cc8e6aec17440df5d4c38d7545b7a250e05444c9927d83d3815d9f5593917">Checkable</a>
 }</td></tr>
<tr class="memdesc:aaa33cc8e6aec17440df5d4c38d7545b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mode defining how a legend entry interacts.  <a href="class_qwt_legend_data.html#aaa33cc8e6aec17440df5d4c38d7545b7">More...</a><br /></td></tr>
<tr class="separator:aaa33cc8e6aec17440df5d4c38d7545b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55bd21943c804101d956250ca43f93f9"><td class="memItemLeft" align="right" valign="top"><a id="a55bd21943c804101d956250ca43f93f9"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#a55bd21943c804101d956250ca43f93f9">Role</a> { <b>ModeRole</b>, 
<b>TitleRole</b>, 
<b>IconRole</b>, 
<b>UserRole</b> = 32
 }</td></tr>
<tr class="memdesc:a55bd21943c804101d956250ca43f93f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier how to interprete a QVariant. <br /></td></tr>
<tr class="separator:a55bd21943c804101d956250ca43f93f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a519e4f01583d051e4b2458ab9dfcb196"><td class="memItemLeft" align="right" valign="top"><a id="a519e4f01583d051e4b2458ab9dfcb196"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#a519e4f01583d051e4b2458ab9dfcb196">QwtLegendData</a> ()</td></tr>
<tr class="memdesc:a519e4f01583d051e4b2458ab9dfcb196"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a519e4f01583d051e4b2458ab9dfcb196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56608cc97875e7b3dd9340decd5231cb"><td class="memItemLeft" align="right" valign="top"><a id="a56608cc97875e7b3dd9340decd5231cb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#a56608cc97875e7b3dd9340decd5231cb">~QwtLegendData</a> ()</td></tr>
<tr class="memdesc:a56608cc97875e7b3dd9340decd5231cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a56608cc97875e7b3dd9340decd5231cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68c3bc398c541f345a12fa9321ad52ed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#a68c3bc398c541f345a12fa9321ad52ed">setValues</a> (const QMap&lt; int, QVariant &gt; &amp;)</td></tr>
<tr class="separator:a68c3bc398c541f345a12fa9321ad52ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7a22d8fd13cce97d49eef4f48b897f7"><td class="memItemLeft" align="right" valign="top">const QMap&lt; int, QVariant &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#ad7a22d8fd13cce97d49eef4f48b897f7">values</a> () const</td></tr>
<tr class="separator:ad7a22d8fd13cce97d49eef4f48b897f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1be4b4cf3c1df733744633ea6c02346a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#a1be4b4cf3c1df733744633ea6c02346a">setValue</a> (int role, const QVariant &amp;)</td></tr>
<tr class="separator:a1be4b4cf3c1df733744633ea6c02346a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d7b579487291f78d9cc26b59b53e32f"><td class="memItemLeft" align="right" valign="top">QVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#a6d7b579487291f78d9cc26b59b53e32f">value</a> (int role) const</td></tr>
<tr class="separator:a6d7b579487291f78d9cc26b59b53e32f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfa62dcccd380d9ba41cd24923c1155f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#abfa62dcccd380d9ba41cd24923c1155f">hasRole</a> (int role) const</td></tr>
<tr class="separator:abfa62dcccd380d9ba41cd24923c1155f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4965e8711b0b4cb899b673fe8525392"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#aa4965e8711b0b4cb899b673fe8525392">isValid</a> () const</td></tr>
<tr class="separator:aa4965e8711b0b4cb899b673fe8525392"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea7d1ab69cc1cab86a949b48b92a71b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_qwt_graphic.html">QwtGraphic</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#aea7d1ab69cc1cab86a949b48b92a71b4">icon</a> () const</td></tr>
<tr class="separator:aea7d1ab69cc1cab86a949b48b92a71b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8a49f7a6cc6991815f3163b21d70d44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_qwt_text.html">QwtText</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#af8a49f7a6cc6991815f3163b21d70d44">title</a> () const</td></tr>
<tr class="separator:af8a49f7a6cc6991815f3163b21d70d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08a30173e015c7e743ae257f9ceb4736"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_qwt_legend_data.html#aaa33cc8e6aec17440df5d4c38d7545b7">Mode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_qwt_legend_data.html#a08a30173e015c7e743ae257f9ceb4736">mode</a> () const</td></tr>
<tr class="separator:a08a30173e015c7e743ae257f9ceb4736"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Attributes of an entry on a legend. </p>
<p><a class="el" href="class_qwt_legend_data.html" title="Attributes of an entry on a legend. ">QwtLegendData</a> is an abstract container ( like QAbstractModel ) to exchange attributes, that are only known between to the plot item and the legend.</p>
<p>By overloading <a class="el" href="class_qwt_plot_item.html#a367ed5160b8475daf6b5b06558310f98" title="Return all information, that is needed to represent the item on the legend. ">QwtPlotItem::legendData()</a> any other set of attributes could be used, that can be handled by a modified ( or completely different ) implementation of a legend.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_legend.html" title="The legend widget. ">QwtLegend</a>, <a class="el" href="class_qwt_plot_legend_item.html" title="A class which draws a legend inside the plot canvas. ">QwtPlotLegendItem</a> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The stockchart example implements a legend as a tree with checkable items </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aaa33cc8e6aec17440df5d4c38d7545b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa33cc8e6aec17440df5d4c38d7545b7">&#9670;&nbsp;</a></span>Mode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_qwt_legend_data.html#aaa33cc8e6aec17440df5d4c38d7545b7">QwtLegendData::Mode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Mode defining how a legend entry interacts. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aaa33cc8e6aec17440df5d4c38d7545b7add4342fbe2d82828b9ef7031c1b41a0b"></a>ReadOnly&#160;</td><td class="fielddoc"><p>The legend item is not interactive, like a label. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa33cc8e6aec17440df5d4c38d7545b7a39077c66db9fe2faf4d85a6f9266583f"></a>Clickable&#160;</td><td class="fielddoc"><p>The legend item is clickable, like a push button. </p>
</td></tr>
<tr><td class="fieldname"><a id="aaa33cc8e6aec17440df5d4c38d7545b7a250e05444c9927d83d3815d9f5593917"></a>Checkable&#160;</td><td class="fielddoc"><p>The legend item is checkable, like a checkable button. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abfa62dcccd380d9ba41cd24923c1155f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfa62dcccd380d9ba41cd24923c1155f">&#9670;&nbsp;</a></span>hasRole()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QwtLegendData::hasRole </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>role</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">role</td><td>Attribute role </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True, when the internal map has an entry for role </dd></dl>

</div>
</div>
<a id="aea7d1ab69cc1cab86a949b48b92a71b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea7d1ab69cc1cab86a949b48b92a71b4">&#9670;&nbsp;</a></span>icon()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_qwt_graphic.html">QwtGraphic</a> QwtLegendData::icon </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Value of the IconRole attribute </dd></dl>

</div>
</div>
<a id="aa4965e8711b0b4cb899b673fe8525392"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4965e8711b0b4cb899b673fe8525392">&#9670;&nbsp;</a></span>isValid()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QwtLegendData::isValid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>True, when the internal map is empty </dd></dl>

</div>
</div>
<a id="a08a30173e015c7e743ae257f9ceb4736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08a30173e015c7e743ae257f9ceb4736">&#9670;&nbsp;</a></span>mode()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_qwt_legend_data.html#aaa33cc8e6aec17440df5d4c38d7545b7">QwtLegendData::Mode</a> QwtLegendData::mode </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Value of the ModeRole attribute </dd></dl>

</div>
</div>
<a id="a1be4b4cf3c1df733744633ea6c02346a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1be4b4cf3c1df733744633ea6c02346a">&#9670;&nbsp;</a></span>setValue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QwtLegendData::setValue </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>role</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QVariant &amp;&#160;</td>
          <td class="paramname"><em>data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set an attribute value</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">role</td><td>Attribute role </td></tr>
    <tr><td class="paramname">data</td><td>Attribute value</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_legend_data.html#a6d7b579487291f78d9cc26b59b53e32f">value()</a> </dd></dl>

</div>
</div>
<a id="a68c3bc398c541f345a12fa9321ad52ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68c3bc398c541f345a12fa9321ad52ed">&#9670;&nbsp;</a></span>setValues()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QwtLegendData::setValues </td>
          <td>(</td>
          <td class="paramtype">const QMap&lt; int, QVariant &gt; &amp;&#160;</td>
          <td class="paramname"><em>map</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the legend attributes</p>
<p><a class="el" href="class_qwt_legend_data.html" title="Attributes of an entry on a legend. ">QwtLegendData</a> actually is a QMap&lt;int, QVariant&gt; with some convenience interfaces</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">map</td><td>Values </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_legend_data.html#ad7a22d8fd13cce97d49eef4f48b897f7">values()</a> </dd></dl>

</div>
</div>
<a id="af8a49f7a6cc6991815f3163b21d70d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8a49f7a6cc6991815f3163b21d70d44">&#9670;&nbsp;</a></span>title()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_qwt_text.html">QwtText</a> QwtLegendData::title </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Value of the TitleRole attribute </dd></dl>

</div>
</div>
<a id="a6d7b579487291f78d9cc26b59b53e32f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d7b579487291f78d9cc26b59b53e32f">&#9670;&nbsp;</a></span>value()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QVariant QwtLegendData::value </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>role</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">role</td><td>Attribute role </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Attribute value for a specific role </dd></dl>

</div>
</div>
<a id="ad7a22d8fd13cce97d49eef4f48b897f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7a22d8fd13cce97d49eef4f48b897f7">&#9670;&nbsp;</a></span>values()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const QMap&lt; int, QVariant &gt; &amp; QwtLegendData::values </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Legend attributes </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_qwt_legend_data.html#a68c3bc398c541f345a12fa9321ad52ed">setValues()</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_qwt_legend_data.html">QwtLegendData</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
  </ul>
</div>
</body>
</html>
